VideoDecoder: configure()-Methode

Limited availability

This feature is not Baseline because it does not work in some of the most widely-used browsers.

Sicherer Kontext: Diese Funktion ist nur in sicheren Kontexten (HTTPS) in einigen oder allen unterstützenden Browsern verfügbar.

Hinweis: Diese Funktion ist in Dedicated Web Workers verfügbar.

Die configure()-Methode der VideoDecoder-Schnittstelle stellt eine Steuerungsnachricht in die Warteschlange, um den Videodecoder für das Decodieren von Datenblöcken zu konfigurieren.

Syntax

js
configure(config)

Parameter

config

Ein Objekt, das die folgenden Mitglieder enthält:

codec

Ein String, der einen gültigen Codec-String enthält. Siehe "codecs"-Parameter für Details zur Erstellung von Codec-Strings.

description Optional

Ein ArrayBuffer, ein TypedArray oder ein DataView, der eine Sequenz von codec-spezifischen Bytes enthält, üblicherweise als "extradata" bekannt.

codedWidth Optional

Ein Integer, der die Breite des VideoFrame in Pixeln darstellt, einschließlich jeglicher nicht sichtbarer Auffüllung, bevor Anpassungen des Seitenverhältnisses vorgenommen werden.

codedHeight Optional

Ein Integer, der die Höhe des VideoFrame in Pixeln darstellt, einschließlich jeglicher nicht sichtbarer Auffüllung, bevor Anpassungen des Seitenverhältnisses vorgenommen werden.

displayAspectWidth Optional

Ein Integer, der die horizontale Dimension des VideoFrame in Pixeln bei der Anzeige darstellt.

displayAspectHeight Optional

Ein Integer, der die vertikale Dimension des VideoFrame in Pixeln bei der Anzeige darstellt.

colorSpace Optional

Ein Objekt, das einen VideoColorSpace darstellt und folgende Mitglieder enthält:

primaries

Ein String, der den Farb-Gamut des Videobeispiels repräsentiert. Einer von:

  • "bt709"
  • "bt470bg"
  • "smpte170m"
transfer

Ein String, der Übertragungscharakteristiken darstellt. Einer von:

  • "bt709"
  • "smpte170m"
  • "iec61966-2-1"
matrix

Ein String, der einen Matrixkoeffizienten darstellt. Einer von:

  • "rgb"
  • "bt709"
  • "bt470bg"
  • "smpte170m"
hardwareAcceleration Optional

Ein Hinweis auf die zu verwendende Hardware-Beschleunigungsmethode. Einer von:

  • "no-preference"
  • "prefer-hardware"
  • "prefer-software"
optimizeForLatency Optional

Ein boolescher Wert. Wenn true, ist dies ein Hinweis darauf, dass der ausgewählte Decoder so optimiert werden sollte, dass die Anzahl der zu decodierenden EncodedVideoChunk-Objekte minimiert wird, bevor ein VideoFrame ausgegeben wird.

Hinweis: Die Einträge im WebCodecs Codec Registry verweisen auf eine Spezifikation, die beschreibt, ob und wie das optionale description-Mitglied gefüllt werden soll.

Rückgabewert

Keiner (undefined).

Ausnahmen

TypeError

Wird ausgelöst, wenn das bereitgestellte config ungültig ist.

InvalidStateError DOMException

Wird ausgelöst, wenn der state "closed" ist.

NotSupportedError DOMException

Wird ausgelöst, wenn das bereitgestellte config gültig ist, aber der User Agent keinen Codec bereitstellen kann, der dieses Profil decodieren kann.

Beispiele

Das folgende Beispiel erstellt einen neuen VideoDecoder und konfiguriert ihn mit dem "vp8"-Codec, einem codedWidth von 640 Pixeln und einem codedHeight von 480 Pixeln.

js
const init = {
  output: handleFrame,
  error(e) {
    console.log(e.message);
  },
};

const config = {
  codec: "vp8",
  codedWidth: 640,
  codedHeight: 480,
};

let decoder = new VideoDecoder(init);
decoder.configure(config);

Spezifikationen

Specification
WebCodecs
# dom-videodecoder-configure

Browser-Kompatibilität